This resource address returns configuration information on a specific host. The
host can be identified either by id or name.
URL Parameters
view
A specific view of the returned data. Can be either
schema, status, metrics, or default.
format
The format of the returned data. Can be either
html, json, or xml (default). This value overrides
the Accept header if both are present.
Request Headers
Accept
The expected MIME type of the response. If the
format parameter is present, it takes precedence over the Accept header.
Content-type
The MIME type of the data in the request
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
Response Headers
Content-type
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
Response
Upon success, MarkLogic Server returns status code 200 (OK), and the response
body contains the requested data.
Required Privileges
This operation requires the manage-user role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage
Usage Notes
The structure of the output returned from
this REST API is as follows:
id
A host unique id (64-bit value).
name
The name of the Host
meta
Properties of the view rather than the resource.
This is a complex structure with the following children:
uri
The path to the view.
current-time
The timestamp for when the view was generated.
elapsed-time
The time required to construct the view. The
elapsed time indicates the relative cost of generating the view. Consider
the cost when determining how frequently to request a view.
start-min
The timestamp for filtering out more recent
requests or transactions.
view-error
An error limiting the data in the view.
This is a complex structure with the following children:
error-type
The kind of error.
error-name
The name of the error.
error-code
The error identifier.
error-message
The error text.
config-properties
The configuration characteristics of the host.
This is a complex structure with the following children:
host-mode
Mode of this host
host-mode-description
The description for this host mode
bind-port
The distributed protocol server socket bind internet port number.
connect-port
The distributed protocol client socket connect internet port number.
foreign-bind-port
The distributed protocol server socket bind internet port number.
foreign-connect-port
The distributed protocol client socket connect internet port number.
ssl-certificate-old
The old PEM encoded certificate for the host. If the 'file' attribute is
present, it is a file containing the PEM encoded certificate.
ssl-certificate-new
The new PEM encoded certificate for the host. If the 'file' attribute is
present, it is a file containing the PEM encoded certificate.
zone
Zone the host belongs to.
bootstrap-host
related-views
A list of broader or narrower views on the resource or resource type.
This is a complex structure with the following children:
related-view
A broader or narrower view on the resource or resource type.
This is a complex structure with the following children:
view-type
The kind of view.
view-name
The name of the view.
view-uri
The path for the view.
Example
http://localhost:8002/manage/v2/hosts/myhost?view=config&format=json
==> Returns configuration information on the 'myhost' host, as JSON.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.